docs/development/Building in Windows.md

   1 # Building in windows
   2
   3
   4 ## Bash On Windows 10
   5
   6 A new feature in Windows 10 allows any developer to quickly and easily run an entire linux subsystem in windows and access it via a bash terminal. This gives developers full use of the entire linux OS and all of the great existing linux tools and programs. When Bash for Windows is up and running it feels like you sshed into a full linux box, except the linux distro is actually running alongside windows locally.
   7
   8 If you use Bash on Windows you can easily build cleanflight exactly as you would for Ubuntu. (the linux distro running on Windows is Ubuntu Trusty)
   9
  10 Setup for Bash on Windows is very easy and takes less than 5 minutes. [For instructions follow the official guide here.](https://msdn.microsoft.com/commandline/wsl/install_guide)
  11
  12 Once you have Bash On Windows running you can follow the "Building in Ubuntu" instructions for building cleanfight.
  13
  14 ##Setup Cygwin
  15
  16 download the Setup*.exe from https://www.cygwin.com/
  17
  18 ![Cygwin Installation](assets/001.cygwin_dl.png)
  19
  20 Execute the download Setup and step through the installation  wizard (no need to customize the settings here). Stop at the  "Select Packages" Screen and select the following Packages
  21 for Installation:
  22
  23 - Devel/git
  24 - Devel/bash-completion (was git-completion, Optional)
  25 - Devel/make
  26 - Devel/binutils
  27 - Editors/vim
  28 - Editors/vim-common (Optional)
  29 - Shells/mintty (should be already selected)
  30
  31 ![Cygwin Installation](assets/002.cygwin_setup.png)
  32
  33 ![Cygwin Installation](assets/003.cygwin_setup.png)
  34
  35 ![Cygwin Installation](assets/004.cygwin_setup.png)
  36
  37 ![Cygwin Installation](assets/005.cygwin_setup.png)
  38
  39 ![Cygwin Installation](assets/006.cygwin_setup.png)
  40
  41
  42 Continue with the Installation and accept all autodetected dependencies.
  43
  44 ![Cygwin Installation](assets/007.cygwin_setup.png)
  45
  46
  47 ##Setup GNU ARM Toolchain
  48
  49 ----------
  50
  51 versions do matter, 5.4 is known to work well. Download this version from https://launchpad.net/gcc-arm-embedded/5.0/5-2016-q2-update/+download/gcc-arm-none-eabi-5_4-2016q2-20160622-win32.zip
  52
  53
  54 Extract the contents of this archive to any folder of your choice, for instance ```C:\dev\gcc-arm```.
  55
  56 ![GNU ARM Toolchain Setup](assets/008.toolchain.png)
  57
  58 add the "bin" subdirectory to the PATH Windows environment variable: ```%PATH%;C:\dev\gcc-arm\bin```
  59
  60 ![GNU ARM Toolchain Setup](assets/009.toolchain_path.png)
  61
  62 ![GNU ARM Toolchain Setup](assets/010.toolchain_path.png)
  63
  64 ## Checkout and compile Cleanflight
  65
  66 Head over to the Cleanflight Github page and grab the URL of the GIT Repository: "https://github.com/cleanflight/cleanflight.git"
  67
  68 Open the Cygwin-Terminal, navigate to your development folder and use the git commandline to checkout the repository:
  69
  70 ```bash
  71 cd /cygdrive/c/dev
  72 git clone https://github.com/cleanflight/cleanflight.git
  73 ```
  74 ![GIT Checkout](assets/011.git_checkout.png)
  75
  76 ![GIT Checkout](assets/012.git_checkout.png)
  77
  78 To compile your Cleanflight binaries, enter the cleanflight directory and build the project using the make command. You can append TARGET=[HARDWARE] if you want to build anything other than the default NAZE target:
  79
  80 ```bash
  81 cd cleanflight
  82 make TARGET=NAZE
  83 ```
  84
  85 ![GIT Checkout](assets/013.compile.png)
  86
  87 within few moments you should have your binary ready:
  88
  89 ```bash
  90 (...)
  91 arm-none-eabi-size ./obj/main/cleanflight_NAZE.elf
  92    text    data     bss     dec     hex filename
  93   95388     308   10980  106676   1a0b4 ./obj/main/cleanflight_NAZE.elf
  94 arm-none-eabi-objcopy -O ihex --set-start 0x8000000 obj/main/cleanflight_NAZE.elf obj/cleanflight_NAZE.hex
  95 ```
  96
  97 You can use the Cleanflight-Configurator to flash the ```obj/cleanflight_NAZE.hex``` file.
  98
  99 ## Updating and rebuilding
 100
 101 Navigate to the local cleanflight repository and use the following steps to pull the latest changes and rebuild your version of cleanflight:
 102
 103 ```bash
 104 cd /cygdrive/c/dev/cleanflight
 105 git reset --hard
 106 git pull
 107 make clean TARGET=NAZE -j16 -l
 108 make
 109 ```
 110
 111 You may want to remove -j16 -l if your having a hard time narrowing down errors.  It does multithreaded make, however it makes it harder to know which warning or error comes from which file.
 112